TINKERPOP-2995 Create Sample Applications in each GLV#2298
TINKERPOP-2995 Create Sample Applications in each GLV#2298Cole-Greer merged 54 commits intoapache:3.7-devfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 3.7-dev #2298 +/- ##
=============================================
- Coverage 76.17% 76.15% -0.02%
+ Complexity 13113 13109 -4
=============================================
Files 1083 1083
Lines 64995 64995
Branches 7259 7259
=============================================
- Hits 49510 49500 -10
- Misses 12789 12794 +5
- Partials 2696 2701 +5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
FlorianHockmann
left a comment
There was a problem hiding this comment.
I only reviewed the .NET example. Apart from my minor inline comments, I have two general questions:
- Are the examples already included in our build pipeline? Because it looks to me like they aren't built via GH Actions.
- How do we want to use the examples / How do we make users aware of them?
|
@FlorianHockmann The examples aren't integrated into the pipeline or GH actions, but they are self-contained as simple projects in their respective |
I think we should look into adding them to the main Maven build and at least add a smoke test for them (like executing the methods to ensure that no exception gets thrown) so they are covered by GH actions. Otherwise, we won't notice if we break them, e.g., by changing some API.
I think a short mention in the reference docs for each GLV would be great as that is the place where we mostly document the GLVs. README files could of course also make sense, especially if the applications contain more than a single file (depending on @kenhuuu's comment) to briefly explain the application and its structure. README's are usually also what search engines will link to so that's where users will land if they didn't follow a link from somewhere else in our docs. We should probably also remove the current Gremlin.Net.Template (docs src) as it basically served the same purpose and we don't need two example applications for .NET. |
if we use a nonstandard port i think it would be good to ensure the comments are clear that the standard port is 8182. |
|
Maybe I'm also overcautious here and we don't need any tests. Ensuring that the applications still compile probably already covers most cases as we would already notice breaking changes. But then I would at least let GH actions build the applications which should be easy to do by integrating them into the Maven build. |
…erpop into ryan/glv-examples
This has already turned out to be a really good idea as #2366 would already cause these examples to break eventually. |
Cole-Greer
left a comment
There was a problem hiding this comment.
Thanks Ryan! Overall the changes here look good to me, just added a few minor comments.
gremlin-driver/src/main/java/examples/dependency-reduced-pom.xml
Outdated
Show resolved
Hide resolved
|
Thanks for all the updates Ryan! VOTE +1 |
|
VOTE+1 |
https://issues.apache.org/jira/browse/TINKERPOP-2995
Created sample applications for each GLV in Java, Python, C#, JS, and Go which includes connection, basic Gremlin, and simple traversal examples.